GUI_State.h

Go to the documentation of this file.

#ifndef GUI_STATE_H_
#define GUI_STATE_H_

/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif

#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif

#define GUI_STATE_RUN_HAS_BEEN_EXECUTED ((uint8_t)0xA5u)
#define N_GUI_ARGS ((uint8_t)3u)

/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

/*** Enums ***/


/*** TypeDefs ***/
typedef union
{
  struct
  {
    uint8_t Cmd;
    uint8_t Arg1;
    uint8_t Arg2;
    uint8_t Arg3;
  } P;
  
  uint8_t A[4];
  
  uint32_t W;
} GUICmd_t;

typedef union
{
  uint8_t A[4];
} GUICmdString_t;
/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Global ***/
/*** Static ***/

/*** Constant ***/
/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          u32fnGUISwitchCase()
 *
 */
uint32_t u32fnGUISwitchCase(const uint8_t* pu8Cmd, 
                            uint8_t* pu8RawResponse, 
                            uint8_t* pu8Size,
                            uint8_t* pu8TextResponse,
                            uint8_t* pu8TextSize);
/*
 ******************************************************************************
 *
 * Function:          vfnGUIStateFormatCurveData()
 *
 */
void vfnGUIStateFormatCurveData(uint16_t* au16LabviewData);
/*
 ******************************************************************************
 *
 * Function:          u32fnGUISendResponseFrame()
 *
 */
uint32_t u32fnGUISendResponseFrame(const uint8_t* pu8Cmd,
                                   const uint8_t* pu8RawResponse, 
                                   const uint8_t* pu8Size,
                                   const uint8_t* pu8TextResponse,
                                   const uint8_t  u8TextSize);
/*
 ******************************************************************************
 *
 * Function:          vfnGUISBCCapTests()
 *
 */
void vfnGUISBCCapTests(uint8_t* pu8Size, uint8_t* pu8RawResponse,
                       uint8_t u8ERx, uint8_t u8Test);
/*
 ******************************************************************************
 *
 * Function:          vfnGUISBCLeakageTests()
 *
 */
void vfnGUISBCLeakageTests(const uint8_t cu8Side,
                           const uint8_t cu8Squib, 
                           const uint8_t cu8LeakageType, 
                           uint8_t* pu8Result);
/*
 ******************************************************************************
 *
 * Function:          vfnGUICheckSatellites()
 *
 */
void vfnGUICheckSatellites(const uint16_t* pu16Mask, 
                           uint8_t* pu8Result);
/*
 ******************************************************************************
 *
 * Function:          vfnVerifyValidityOfCmd()
 *
 */
void vfnVerifyValidityOfCmd(const uint8_t* pu8Cmd, 
                            const GUICmdString_t* ptValidCmd,
                            const uint16_t u16TableSize,
                            uint8_t* pu8Result);
/*
 ******************************************************************************
 *
 * Function:          vfnGUISatAndSquibState()
 *
 */
void vfnGUISatAndSquibState(const uint8_t u8Mode, const uint16_t cu16Step);
#endif /* GUI_STATE_H_ */